SERVICE

Yes

SERVICE specifies the name of the service in Site.Service format.

SITE.FMS

SVC_PORT

Yes

The SVC_PORT keyword specifies the UDP port number for this service. Each service on the computer must have a unique port number. Use the Config File Manager to ensure that all ports for all services on a given server are unique.

XXXX

(as available)

FMS_MODE

Yes

Mode for which the FMS is licensed. The mode determines the available feature set.

The FMS-MODE (Available feature set) info item reports the value of this keyword.

[Provided according to licensed mode]

REDUNDANT

No

REDUNDANT indicates whether Redundancy is enabled for this service and it is part of a redundant set with other services.

• Set to TRUE to enable Redundancy for this service and indicate that it is in a redundant relationship with another service within the redundancy environment.
• Set to FALSE or commented out to disable Redundancy for this service.

See Redundancy for more configuration details. A redundancy definition for your CygNet environment is configured in the CygNet Redundancy Editor.

The IN_REDUNDANT_SET (Service in redundant set) info item will report whether this service is part of a redundant relationship.

FALSE

ACS

Yes

The Site and Service name of the service’s ACS, in Site.Service format.

SITE.ACS

AUD

Yes

The Site and Service name of the service’s AUD, in Site.Service format.

SITE.AUD

ELS

Yes

The Site and Service name of the service’s ELS, in Site.Service format.

SITE.ELS

MSS

Yes

The Site and Service name of the MSS from which commands will be accepted, in Site.Service format.

SITE.MSS

AUTHORIZED_SERVICES

No

Specifies which additional MSS services can send FMS commands. Limited to 10 services.

None

EMAIL_AUTH_MODE

No

Specifies the user authentication mode used by FMS to connect to an email server

Options are as follows.

• Basic — Basic authentication (SMTP) is the legacy option to connect to a hosted email service. Select this option to use the specified SMTP_SERVER wherein the client application will pass the SMTP_USERNAME and SMTP_PASSWORD with every request.

  When Basic is selected, EMAIL_OAUTH_* keyword values are not used.

• OAuth2 — OAuth2.0 authorization is a far more secure protocol for accessing and sharing information. Select this option to use the specified EMAIL_OAUTH_TYPE provider (Microsoft) for authorization.

  When OAuth2 is selected, SMTP_* keyword values are not used.

Basic

EMAIL_OAUTH_TYPE

No

If using OAuth2 authorization, specifies the provider for the OAuth2 authorization mode

Currently, the only valid provider type for OAuth2 authorization is Microsoft. Microsoft enables authorization access to Microsoft Cloud service resources, including Microsoft 365 and Azure Active Directory (Azure AD).

Microsoft

EMAIL_OAUTH_AUTHORITY

No

If using OAuth2 authorization, specifies the Authority URI for the OAuth2 authority

The authority URI is a URL that indicates a directory that the Microsoft Authentication Library (MSAL) can request tokens from.

https://login.microsoftonline.com

EMAIL_OAUTH_TENANT

No

If using OAuth2 authorization, specifies the Authority tenant ID for the OAuth2 authority

The tenant ID is a globally unique identifier (GUID) associated with the Microsoft Azure Active Directory (Azure AD) instance for your organization.

tenant

EMAIL_OAUTH_CLIENT_ID

No

If using OAuth2 authorization, specifies the Client ID assigned by the OAuth2 authority to the FMS

The client ID is created when you register the FMS with the Microsoft Azure AD portal.

client_id

EMAIL_OAUTH_CLIENT_SECRET

No

If using OAuth2 authorization, specifies the Client secret known only to the OAuth2 authority and the FMS

The client secret is created when you register the FMS with the Microsoft Azure AD portal.

client_secret

SMTP_SERVER

No

If using Basic authentication, specifies the name of the SMTP email server

None

SMTP_USERNAME

No

If using Basic authentication, specifies the username required for authentication by the SMTP email server

None

SMTP_PASSWORD

No

If using Basic authentication, specifies the user password required for authentication by the SMTP email server

None

DB_PROVIDER

Yes

The name of the database provider

MSOLEDBSQL

DB_SERVER

Yes

The path to the database, whether to the internal database file or to the external server hosting your FMS database

FmsServer

DB_CATALOG

Yes (for SQL DB)

No (for Internal DB)

The name of the SQL database created for your FMS Service.

Not applicable if using the internal database. If provided, it will be ignored.

FmsDb

DB_USERNAME

No

Specifies a username.

Optional for SQL database.

Not applicable if using the internal database.

<UID>

DB_PASSWORD

No

Specifies a password.

Optional for SQL database.

Not applicable if using the internal database.

<PWD>

DB_QUERYTIMEOUT

No

Specifies the timeout of a database query (in seconds).

None; uncomment and enter a value (in seconds) to use

DATA_RETENTION

No

When this keyword is set, the value entered specifies the minimum number of days to retain data in the FMS database (whether internal or SQL).

No Archiving

When archiving is not defined, once data is older than this specified retention period, it can only be removed by executing an FMS database maintenance command, using the "Purge expired device data" feature. See Perform Database Maintenance for more information.

Archiving

When archiving is defined (the ARCHIVE_PATH keyword is valid), data older than this specified number of days will be moved out of the database into the archive files when an Archive Data command is run.

Data Synchronization / Replication

Data Synchronization keywords can define replication roles for your system. When so configured, this value specifies the number of days to maintain data in the database for the Master service for data synchronization purposes.

For a replicated Business Slave service, this value specifies the number of days of data to be replicated from the Master service to the Slave service.

See FMS Data Synchronization for more information.

No limit

Initially, this keyword is commented out by default, which means that no limit is set (all data is retained).

When the keyword is uncommented, a valid value is required.

ARCHIVE_PATH

No

Specifies the location of the file directory to which archived data files will be saved. (Data in the archived files can be accessed to populate CygNet Measurement reports.)

None

Initially, this keyword is commented out by default.

When the keyword is uncommented, a valid file path value is required.

FCDB_SERVER

Yes (for connections to Flow-Cal database)

No (otherwise)

The IP address, or host name, of the server hosting the database used for Flow-Cal data.

Not applicable unless using optional FMS functionality requiring the Flow-Cal database.

FCDBServer

FCDB_PORT

No

This parameter is optional. When provided, it may be used for connections to the Flow-Cal database, when the service name provided is not solely sufficient to resolve to the database successfully.

The communication port assignment for connecting to the database used for Flow-Cal data.

Must be a unique port number.

Not applicable unless using optional FMS functionality requiring the Flow-Cal database.

FCDBPort

FCDB_CATALOG

No

This parameter is optional. When provided, it may be used for connections to the Flow-Cal database, when the service name provided is not solely sufficient to resolve to the database successfully.

The name of the database used for Flow-Cal data.

Not applicable unless using optional FMS functionality requiring the Flow-Cal database.

FCDB

FCDB_USERNAME

Yes

Specifies a schema or username for accessing the database used for Flow-Cal data.

Not applicable unless using optional FMS functionality requiring the Flow-Cal database.

FCDBUsername

FCDB_PASSWORD

Yes

Specifies a password for accessing the database used for Flow-Cal data.

Not applicable unless using optional FMS functionality requiring the Flow-Cal database.

FCDBPassword

ACS_ID

Yes

The User ID of the service. This keyword is required for performing security events.

FMS

ACS_APPLICATION

Yes

The service’s application name for security.

FMS

MAIN_SEC_EVENT

Yes

The main security event for this application. The value must be all uppercase, with a maximum of 8 characters.

ACCESS

CORE_QUEUE_SIZE

No

Tracks all core changes related to system configuration

50000

NODE_QUEUE_SIZE

No

Tracks all changes related to Node records, including group entry records

50000

SUPPORT_QUEUE_SIZE

No

Tracks all core support changes related to system configuration

50000

DELETE_QUEUE_SIZE

No

Tracks manual deletes of device data Expect minimal changes.

1000000

DEVICE_DATA_QUEUE_SIZE

No

Tracks device-based data

Expect constant change linear to system use.

1000000

PROCESS_QUEUE_SIZE

No

Tracks process changes

Expect slow linear growth as system is used.

1000000

JOB_QUEUE_SIZE

No

Tracks all changes related to job records

1000000

AUDIT_DEVICE

Yes

Specifies that any adds, deletes, or updates to NodeDevice records will be audited.

NODE_ID

REPORTING_FAC

POLLING_FAC

AUDIT_GROUP

Yes

Specifies that any adds, deletes, or updates to NodeGroup records will be audited.

NODE_ID

REPORTING_FAC

AUDIT_GROUP_ENTRY

Yes

Specifies that any adds, deletes, or updates to GroupEntryStation, or GroupEntryGeneral records will be audited.

NODE_ID

AUDIT_GAS_COMP_SPLIT

Yes

Specifies that any adds, deletes, or updates to GasCompositionSplit records will be audited.

FMS_ID

AUDIT_VALIDATION_RULE

Yes

Specifies that any adds, deletes, or updates to ValidationEngine, ValidationRuleSet, and ValidationRule records will be audited.

FMS_ID

AUDIT_ESTIMATION_RULE

Yes

Specifies that any adds, deletes, or updates to EstimationEngine and EstimationRule records will be audited.

FMS_ID

AUDIT_SYSTEM_SETTING

Yes

Specifies that any adds, deletes, or updates to SystemSetting and SystemSettingDetail records will be audited.

FMS_ID

AUDIT_UNIT_SET

Yes

Specifies that any adds, deletes, or updates to UnitSet records will be audited.

FMS_ID

AUDIT_AUDIT_CAT

Yes

Specifies that any adds, deletes, or updates to AuditCategory records will be audited.

FMS_ID

AUDIT_DATA_QUALITY

Yes

Specifies that any adds, deletes, or updates to DataQuality records will be audited.

FMS_ID

AUDIT_NORMALIZATION_VIEW

Yes

Specifies that any adds, deletes, or updates to NormalizationDef and NormalizationDefDetail records will be audited.

FMS_ID

AUDIT_GROUP_CATEGORY

Yes

Specifies that any adds, deletes, or updates to GroupCategory records will be audited.

FMS_ID

DS_MODE

For FMS Replication: Required when data synchronization is desired.

For FMS Redundancy: Do not configure, leave commented.

For FMS Replication:

Defines the data sharing mode of the current service, indicating whether replication is set up.

Possible values for DS_MODE are as follows:

• REPLICATION — Set up replication for this service, as defined by additional keyword values
• NONE — No replication set up for this service

NONE

DS_ROLES

For FMS Replication: Required when in replication mode.

For FMS Redundancy: Do not configure, leave commented.

For FMS Replication:

When DS_MODE = REPLICATION, defines the role of the current service, in relationship to the other data sharing services. A service can only serve one of the following roles at one time.

Possible values for DS_ROLES are as follows:

• REPL_MASTER — Replication Master service, maximum of 1 service can be the Master
• REPL_SLAVE_DR — Replication Disaster Recovery Slave service, maximum of 1 service can be the DR Slave per Master
• REPL_SLAVE_BUSINESS — Replication Business Slave service(s), maximum of 3 services can be Business Slaves per Master

N/A

DS_REPL_MASTER

For FMS Replication: Required when in replication mode, for DR Slave or Business Slave services (for example, when current service is not the Master).

For FMS Redundancy: Do not configure, leave commented.

For FMS Replication:

When DS_MODE = REPLICATION, defines the acting service as the Master service.

Specify the Master service in the format [Domain]Site.Service.

N/A

DS_REPL_SLAVE

For FMS Replication: Required when in replication mode and the current service is the Master - when designating a DR Slave service

(N/A for designating a Business Slave

service).

For FMS Redundancy: Do not configure, leave commented.

For FMS Replication:

When DS_MODE = REPLICATION, and DS_ROLES = REPL_MASTER, defines the DR Slave (disaster recovery) service.

Specify the DR Slave service in the format [Domain]Site.Service.

N/A

DS_CHECK_INTERVAL

For FMS Replication: Required when in replication mode, for DR Slave or Business Slave services

(N/A for the Master service)

For FMS Redundancy: Required when the FMS is included in a redundant environment for data-center failover.

See Configuring FMS Redundancy.

For FMS Replication:

When DS_MODE = REPLICATION, and DS_ROLES = REPL_SLAVE_DR or REPL_SLAVE_BUSINESS, the following applies:

DS_CHECK_INTERVAL sets the interval (in seconds) at which to check for dynamic replication updates from the Master.

For FMS Redundancy:

When including an FMS in a redundant environment for performing data-center failover, the following applies:

DS_CHECK_INTERVAL indicates the interval (in seconds) to check before performing the next replication synchronization. This value determines the replication synchronization frequency.

After performing a sync, a replicating service will subtract the amount of time the sync took from the check interval time to determine how long to wait until the next sync. For example, if the check interval is 60 seconds and the sync takes 40 seconds, the service will only wait 20 seconds before starting the next sync. If the whole sync time exceeds the frequency, then the replicating service will wait for half the sync interval (30 seconds in this case) before starting the next sync.

The FMS_DS_CHK_INTERVAL (Check Interval) info item will report the interval that a replicated service will check the source change queue for new updates. If the service is not replicating FMS_DS_CHK_INTERVAL will respond with an empty string.

30

DS_DELAY_MAX

For FMS Replication: N/A

For FMS Redundancy: Required when the FMS is included in a redundant environment for data-center failover

See Configuring FMS Redundancy.

For FMS Redundancy:

Indicates the number of seconds a service is allowed to be behind in replication before it is considered to be behind. If this keyword is disabled, the value defaults to double the DS_CHECK_INTERVAL time. Best practice recommends enabling and setting a meaningful value for DS_DELAY_MAX for all replicating services. A recommended value would be a longer time interval than you would expect any sync interval to take.

The REPL_DELAY_MAX (Allowed repl delay) info item will report the time elapsed since the service was last fully in sync. Time is calculated as the delta between "now" and the end of the last full sync that has completed. If the time since the last successful sync exceeds the DS_DELAY_MAX value, and the REPL_INT_VAL_STATE (Int repl val state) info item is currently "Normal", then the REPL_INT_VAL_STATE info item is set to "Delayed." The state can only be set back to "Normal" when the time between two syncs is less than the DS_DELAY_MAX time.

60

DS_QUICK_DB_COMPARE

For FMS Replication: Not required when in replication mode:

optional for DR Slave or Business Slave services

For FMS Redundancy:

N/A

For FMS Replication:

For the specified DR Slave, sets whether to use the quick database comparison feature.

If set to TRUE, when an FMS is first started in replication mode, it will do a quick comparison to see if it has the same data as the Master. If it does, then it will skip the full record-by-record comparison and begin replicating.

If set to FALSE, when an FMS is first started in replication mode, it will do a complete record-by-record comparison before it begins replicating.

FALSE

DS_BLACKOUT_START

For FMS Replication: Not required when in replication mode:

optional for DR Slave or Business Slave services

For FMS Redundancy:

N/A

For FMS Replication:

Defines the beginning of a blackout period, during which no replication occurs. Blackout periods are useful to limit replication during polling cycles, maintenance, etc.

00:00

DS_BLACKOUT_END

For FMS Replication: Not required when in replication mode:

optional for DR Slave or Business Slave services

For FMS Redundancy:

N/A

For FMS Replication:

Defines the end of a blackout period, during which no replication occurs. Blackout periods are useful to limit replication during polling cycles, maintenance, etc.

00:00

LOGMASK_ELS

Yes

Specifies the types of service events to be logged to the associated ELS (specified in the ELS keyword). To disable logging to the ELS, comment out the ELS keyword for the selected service. See the Note below this table for more information about the keyword values. The LOGMASK_ELS (LMask ELS) info item will report the value of this keyword.

See LOGMASK_ELS in the Logging section for more information.

CONTROL

EXCEPTIONS

LOGMASK_FILE

Yes

Specifies the type(s) of service events to be logged to the service’s log file ([file name].log). During the current session of the service, data is written to the current log file. Log file names follow the naming convention of the selected logging mode (as set by the LOGFILE_MODE keyword value). See the Note below this table for more information about the keyword values. The LOGMASK_FILE (LMask File) info item will report the value of this keyword.

See LOGMASK_FILE in the Logging section for more information.

CONTROL

EXCEPTIONS

WARNING

LOGFILE_FILE_COUNT

Yes

Specifies the maximum number of log files that a service will create before it starts re-using log files. For example, a count of two will produce SVC001.log, then SVC002.log, and then start back at SVC001.log, where SVC is the name of the service. Specify any value from 2 to 100. The LOGFILE_FILE_COUNT (File Cnt) info item will report the value of this keyword.

See LOGFILE_FILE_COUNT in the Logging section for more information.

2

LOGFILE_FILE_SIZE

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is set to SIZE, this keyword specifies the maximum size (in megabytes) allowed for a log file, before logging will be continued using the next log file. Possible maximum size values are user-determined, respecting the limits of your specific system configuration. The default value is 100 megabytes. When the specified limit is reached, the log finishes the current line, closes the current file, and then continues logging in the next available log file. The LOGFILE_FILE_SIZE (File Size) info item will report the value of this keyword.

See LOGFILE_FILE_SIZE in the Logging section for more information.

100

LOGFILE_LINE_COUNT

Yes

When the value of the LOGFILE_LIMIT_MODE keyword is LINE, this keyword specifies the maximum number of lines per log file. When the specified line count is reached, the log file is truncated at the limit point, and logging is resumed using the next available log file. Specify any value from 1000 to 1000000. The LOGFILE_LINE_COUNT (Line Cnt) info item will report the value of this keyword.

See LOGFILE_LINE_COUNT in the Logging section for more information.

100000

LOGFILE_LIMIT_MODE

Yes

Specifies how to limit the size of each individual log file. Options are LINE (maximum line count is determined by the LOGFILE_LINE_COUNT keyword) or SIZE (maximum file size in megabytes) determined by the LOGFILE_FILE_SIZE keyword). The LOGFILE_LIMIT_MODE (Limit Mode) info item will report the value of this keyword.

The default value is LINE.

See LOGFILE_LIMIT_MODE in the Logging section for more information.

LINE

LOGFILE_MODE

Yes

Specifies the operational mode for the log file, that is, how log files are maintained. Options are LEGACY or EXTENDED. The default value is LEGACY. The LOGFILE_MODE (Logging Mode) info item will report the value of this keyword.

See LOGFILE_MODE in the Logging section for more information.

LEGACY

ENCRYPTION_KEY_FILE

No

ENCRYPTION_KEY_FILE specifies the name and location of the common encryption key file that stores an AES key used to encrypt and decrypt several usernames and passwords used by CygNet Software. The default file location is the root of the Services directory. See Encrypted Keywords for more information. The file should only be read by the user running the related services and any user that needs to run the Config File Manager, which can be used to change (re-encrypt) any related keyword(s). The Config File Manager can be used to create a new encryption key file, if one did not previously exist.

"..\ServiceConfigEncryptionKey"

REPORT_TEMPLATES

No

Specifies the name and location of the file directory folder to which to save report template files used to generate CygNet Measurement reports and populate reports command options

If no value is supplied, the default file location will be used.

By default, this keyword is commented out.

The default file location is the CygNet\Services\FMS\

ReportTemplates folder on your host server.

COMMAND_DEFINITIONS

No

Specifies the name and location of the file directory folder to which to save the .cdf command definition files used to populate optional CygNet Measurement commands in your system

If no value is supplied, the default file location will be used.

By default, this keyword is commented out.

The default file location is the CygNet\Services\FMS\

CommandDefs folder on your host server.